/**
 * Copyright 2010 Nicholas Blair, Eric Dalquist
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.googlecode.ehcache.annotations.resolver;

import java.io.Serializable;

import net.sf.ehcache.Ehcache;

import org.aopalliance.intercept.MethodInvocation;

import com.googlecode.ehcache.annotations.TriggersRemove;
import com.googlecode.ehcache.annotations.key.CacheKeyGenerator;

/**
 * Used to resolve the cache to use at runtime for {@link TriggersRemove} annotated methods
 * 
 * @author Eric Dalquist
 * @version $Revision: 625 $
 */
public interface TriggersRemoveCacheResolver {
    /**
     * @param cacheKey The key generated by the configured {@link CacheKeyGenerator}, null if removeAll is true
     * @param invocation The {@link MethodInvocation} that is being intercepted
     * @return A read-only iterable collection of caches to remove from
     */
    public Iterable<Ehcache> resolveRemoveCaches(Serializable cacheKey, MethodInvocation invocation);
    
    /**
     * @param invocation The {@link MethodInvocation} that is being intercepted
     * @return A read-only iterable collection of caches to remove from
     */
    public Iterable<Ehcache> resolveRemoveAllCaches(MethodInvocation invocation);
}
